/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   Jul 13, 2020 (hornm): created
 */
package org.knime.core.rpc;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * An {@link RpcServer} implementation is used to serve remote requests to one or more node data services.
 *
 * @author Martin Horn, KNIME GmbH, Konstanz, Germany
 * @author Carl Witt, KNIME AG, Zurich, Switzerland
 *
 * @noreference This class is not intended to be referenced by clients.
 * @noextend This class is not intended to be subclassed by clients.
 *
 * @since 4.3
 */
public interface RpcServer {

    /**
     * Returns the service implementation associated to the name <code>serviceInterface.getSimpleName()</code>
     * @param <S> the node data service interface (i.e., the methods offered by the node model to the node dialog/view
     *            to retrieve data)
     * @param serviceInterface an interface the handler implements
     * @return an implementation of the service interface
     */
    default <S> S getHandler(final Class<S> serviceInterface) {
        return getHandler(serviceInterface.getSimpleName());
    }

    /**
     * See {@link #getHandler(Class)}.
     *
     * @param <S> the node data service interface (i.e., the methods offered by the node model to the node dialog/view
     *            to retrieve data)
     * @param serviceName the name of the interface that identifies the implementation of the node data service
     *            interface to return
     * @return a service implementation
     */
    <S> S getHandler(String serviceName);

    /**
     * Handles a single request.
     *
     * @param in contains the request
     * @param out receives the response
     * @throws IOException
     */
    void handleRequest(InputStream in, OutputStream out) throws IOException;

}
